package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AdditionalVariableAddDTO;
import org.jsola.hr.dto.AdditionalVariableBatchDTO;
import org.jsola.hr.dto.AdditionalVariableUpdateDTO;
import org.jsola.hr.query.AdditionalVariableQuery;
import org.jsola.hr.vo.AdditionalVariableListVO;
import org.jsola.hr.vo.AdditionalVariableVO;

import java.util.List;

/**
 * 员工自定义信息关联变量
 *
 * @author zhr
 */
@Api(tags = "hr-员工自定义信息关联变量")
public interface IAdditionalVariableControllerAPI {

    /**
     * 新增员工自定义信息关联变量
     * @param additionalVariableAddDTO 员工自定义信息关联变量新增实体
     * @return 员工自定义信息关联变量展示对象
     */
    @ApiOperation(value = "新增员工自定义信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableAddDTO", dataType = "AdditionalVariableAddDTO", value = "新增员工自定义信息关联变量", paramType = "body")
    })
    Result<AdditionalVariableVO> save(AdditionalVariableAddDTO additionalVariableAddDTO);


    /**
     * 修改员工自定义信息关联变量
     * @param additionalVariableUpdateDTO 员工自定义信息关联变量
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工自定义信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableUpdateDTO", dataType = "AdditionalVariableUpdateDTO", value = "修改员工自定义信息关联变量", paramType = "body")
    })
    Result<Integer> update(AdditionalVariableUpdateDTO additionalVariableUpdateDTO);

    /**
     * 批量编辑、新增、删除员工自定义信息关联变量
     * @param additionalVariableBatchDTO 要操作的员工自定义信息关联变量
     * @return 操作之后的全部员工自定义信息关联变量
     */
    @ApiOperation(value = "批量编辑、新增、删除员工自定义信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableBatchDTO", dataType = "AdditionalVariableBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(AdditionalVariableBatchDTO additionalVariableBatchDTO);



    /**
     * 删除单个员工自定义信息关联变量，彻底删除
     * @param additionalVariableId 员工自定义信息关联变量id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工自定义信息关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableId", dataType = "Long", value = "员工自定义信息关联变量id", paramType = "path")
    })
    Result<Integer> delete(Long additionalVariableId);


    /**
     * 批量删除员工自定义信息关联变量，彻底删除
     * @param additionalVariableIds 员工自定义信息关联变量id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工自定义信息关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableIds", dataType = "Long[]", value = "员工自定义信息关联变量id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] additionalVariableIds);


    /**
     * 根据员工自定义信息关联变量id查询员工自定义信息关联变量详情
     * @param additionalVariableId 员工自定义信息关联变量id
     * @return 员工自定义信息关联变量详情
     */
    @ApiOperation(value="根据员工自定义信息关联变量id查询员工自定义信息关联变量详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableId", dataType = "Long", value = "员工自定义信息关联变量id", paramType = "path")
    })
    Result<AdditionalVariableVO> findById(Long additionalVariableId);


    /**
     * 查询员工自定义信息关联变量
     * @param additionalVariableQuery 员工自定义信息关联变量查询参数
     * @return page
     */
    @ApiOperation(value="查询员工自定义信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableQuery", dataType = "AdditionalVariableQuery", value = "员工自定义信息关联变量查询参数", paramType = "query")
    })
    Result<List<AdditionalVariableListVO>> listAll(AdditionalVariableQuery additionalVariableQuery);


     /**
     * 分页查询员工自定义信息关联变量
     * @param additionalVariableQuery 员工自定义信息关联变量查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工自定义信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "additionalVariableQuery", dataType = "AdditionalVariableQuery", value = "员工自定义信息关联变量查询参数", paramType = "query")
    })
    Result<Page<AdditionalVariableListVO>> page(AdditionalVariableQuery additionalVariableQuery);


}

